Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hdxdsys 731 update RTD data usage guide #134

Merged
merged 8 commits into from
Jun 5, 2024
Merged

Hdxdsys 731 update RTD data usage guide #134

merged 8 commits into from
Jun 5, 2024

Conversation

turnerm
Copy link
Member

@turnerm turnerm commented Jun 4, 2024 •
edited
Loading

This PR mostly covers the text for the data usage portion of the docs. Some other changes:

  • Categories have been broken up to separate files to make them a bit more manageable
  • Tables are all in yaml files to avoid formatting issues
  • Small changes to index.md to align names and ordering with the data grid
  • Briar and Mike will help me resolve the few remaining to-dos, so those will be gone shortly

I still need to do the parameter tables, that will be for another PR

@turnerm turnerm marked this pull request as draft June 4, 2024 20:37
@turnerm turnerm marked this pull request as ready for review June 4, 2024 21:22
@turnerm
Copy link
Member Author

turnerm commented Jun 4, 2024

@danmihaila could Briar (@b-j-mills) be added to this repo? I'd like to make them a reviewer

@alexandru-m-g
Copy link
Member

@turnerm @b-j-mills @danmihaila , I've added Briar to the repo

mcarans
mcarans approved these changes Jun 5, 2024
View reviewed changes
Copy link
Contributor

@mcarans mcarans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

IanHopkinson
IanHopkinson approved these changes Jun 5, 2024
View reviewed changes
Copy link
Collaborator

@IanHopkinson IanHopkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me and useful background

docs/data_usage_guides/enum_parameters/population_status_parameters.yaml Outdated Show resolved Hide resolved
docs/data_usage_guides/enum_parameters/price_flag_parameters.yaml Show resolved Hide resolved
docs/data_usage_guides/enums.md Outdated Show resolved Hide resolved
docs/data_usage_guides/metadata.md Outdated Show resolved Hide resolved
@turnerm turnerm requested a review from b-j-mills June 5, 2024 12:36
b-j-mills
b-j-mills approved these changes Jun 5, 2024
View reviewed changes
Copy link
Collaborator

@b-j-mills b-j-mills left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@alexandru-m-g alexandru-m-g merged commit 5cd08d2 into dev Jun 5, 2024
2 checks passed
@turnerm turnerm deleted the HDXDSYS-731-rtd-hapi-usage branch June 6, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcarans mcarans mcarans approved these changes

@b-j-mills b-j-mills b-j-mills approved these changes

@IanHopkinson IanHopkinson IanHopkinson approved these changes

@alexandru-m-g alexandru-m-g alexandru-m-g approved these changes

@SimonbJohnson SimonbJohnson Awaiting requested review from SimonbJohnson

@cjhendrix cjhendrix Awaiting requested review from cjhendrix

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@turnerm @alexandru-m-g @IanHopkinson @mcarans @b-j-mills